Skip to content

docs: fix typos in RELEASE.md#15619

Merged
jamesfredley merged 1 commit into
8.0.xfrom
docs/release-md-update-for-8.0.0-m1
May 22, 2026
Merged

docs: fix typos in RELEASE.md#15619
jamesfredley merged 1 commit into
8.0.xfrom
docs/release-md-update-for-8.0.0-m1

Conversation

@jamesfredley
Copy link
Copy Markdown
Contributor

@jamesfredley jamesfredley commented May 2, 2026

Summary

Three small typo fixes in RELEASE.md. No version examples are touched - per reviewer feedback, the file should not track the current release version, so the existing v7.0.0-M4 / 7.0.x examples are left as illustrative tags.

Changes

  • Manual Verification: Reproducible Jar Files referenced a non-existent script very-reproducible.sh. Corrected to the actual verify-reproducible.sh.
  • Update ASF Reporter had a small typo: with be -> will be.
  • Appendix: Verification from a Container had an unbalanced backtick in `<git-tag-of-release`. Closed the placeholder.

History

This PR previously also bumped every worked example from v7.0.0-M4 / 7.0.x to v8.0.0-M1 / 8.0.x and changed the manual gradle-bootstrap example from gradle -p gradle-bootstrap to cd gradle-bootstrap && gradle. Both have been reverted on @jdaugherty's review:

  • RELEASE.md is not a per-release document, so the example tag stays as v7.0.0-M4.
  • gradle -p gradle-bootstrap and cd gradle-bootstrap && gradle are functionally identical (-p is the standard --project-dir), so the doc form does not need to change.

Copilot AI review requested due to automatic review settings May 2, 2026 12:57
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@testlens-app

This comment has been minimized.

Copy link
Copy Markdown
Contributor

@jdaugherty jdaugherty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should be updating release.md every major version. the document is meant to be examples - its not supposed to track our versions.

Comment thread RELEASE.md Outdated
Comment thread RELEASE.md Outdated
Apply three small typo fixes discovered while reviewing RELEASE.md:

- `very-reproducible.sh` -> `verify-reproducible.sh` (actual filename
  of the helper script).
- `with be` -> `will be` in the ASF Reporter example.
- Close the unbalanced backtick around `<git-tag-of-release>` in the
  "Appendix: Verification from a Container" section.

Per reviewer feedback, RELEASE.md is not kept in sync with the current
release version; the existing v7.0.0-M4 / 7.0.x examples are left as
illustrative tags.

Assisted-by: claude-code:claude-opus-4-7
@jamesfredley jamesfredley changed the title docs: update RELEASE.md examples for 8.0.0-M1 docs: update RELEASE.md examples May 22, 2026
@jamesfredley jamesfredley force-pushed the docs/release-md-update-for-8.0.0-m1 branch from 7ec72cf to a1cfbc7 Compare May 22, 2026 17:05
@jamesfredley
Copy link
Copy Markdown
Contributor Author

Agreed - reverted the version bumps. RELEASE.md should not track our current version; the existing v7.0.0-M4 / 7.0.x examples are fine as illustrative tags. PR now contains only three pure typo fixes: very-reproducible.sh -> verify-reproducible.sh, with be -> will be, and closing the unbalanced backtick on <git-tag-of-release>.

@jamesfredley jamesfredley changed the title docs: update RELEASE.md examples docs: fix typos in RELEASE.md May 22, 2026
@jamesfredley jamesfredley merged commit 24b4e6a into 8.0.x May 22, 2026
29 checks passed
@jamesfredley jamesfredley deleted the docs/release-md-update-for-8.0.0-m1 branch May 22, 2026 17:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants